Settings Class Reference

List of all members.

Public Member Functions

Settings ($courseid)

addError ($errorString)

resetErrors ()

getDBSettings ()

setName ($name)

setShortname ($shortname)

setModulShortCut ($modulShortCut)

setStyle ($style)

setKeywords ($keywords)

setFAQURL ($faq)

setSemester ($semester)

setOpendate ($opendate)

setClosedate ($closedate)

setRegpass ($regpass)

setMaxStudents ($count)

setUseWaitinglist ($use)

setInfo ($info)

setModulbeschreibung_ID ($modulID)

getID ()

getName ()

getShortname ()

getModulShortCut ()

getKeywords ()

getSemester ()

getOpendate ()

getClosedate ()

getRegpass ()

getUseWaitinglist ()

getMaxStudents ()

getInfo ()

getClosed ()

getStyle ()

getFAQ ()

getCourseType ()

getModulbeschreibung_ID ()

registrationIsActive ()

hasRegistrationStarted ($now)

validateMaxStudents ($maxStudents)

Static Public Member Functions

validateName ($name)

validateShortname ($shortname)

validateKeywords ($keywords)

formatName ($name)

validateRegistrationPassword ($pass)

validateInfo ($info)

formatInfo ($info)

validateStyle ($style)

echoSettingsDialog ()

Public Attributes

$id

$name

$shortname

$modulShortCut

$semester

$keywords

$opendate

$closedate

$regpass

$maxstudents

$usewaitinglist

$closed

$info

$faq_url

$style

$type

$modulbeschreibung_ID

$errors

Member Function Documentation

Settings::addError ( $ errorString )

Fuegt Fehlerstring hinzu.

private

Parameters:

string

$errorString - Fehlerstring

Returns:: void

Settings::echoSettingsDialog ( ) [static]

Gibt einen Dialog fuer die Veranstaltungseinstellungen aus. Verwendet hierzu die Klasse 'SettingsDialog'.

protected

Parameters:

void

Returns:: void

Settings::formatInfo ( $ info ) [static]

Formatiert eine aus einem Formular uebernommene Veranst.-Information.

private

Parameters:

string

$info - Veranstaltungsinformation, die formatiert werden soll. Die Information muss zuvor mit der Methode CourseSettings::checkCourseInfo($info) erfolgreich ueberprueft worden sein.

Returns:: string $info - formatierte Veranstaltungsinformation.

Settings::formatName ( $ name ) [static]

Formatiert einen aus einem Formular uebernommenen Veranst.-Namen.

private

Parameters:

string

$coursename - Veranstaltungsname, der formatiert werden soll. Der Name muss zuvor mit der Methode CourseSettings::checkCoursename($coursename) erfolgreich ueberprueft worden sein.

Returns:: string $coursename - formatierter Veranstaltungsname.

Settings::getClosed ( )

Gibt zurueck, ob der Kurs geschlossen ist.

public

Returns:: integer - 1, falls geschlossen 0, falls nicht

Settings::getClosedate ( )

Gibt das Enddatum fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Enddatum

Settings::getCourseType ( )

Gibt die den Type des Kurses zurück: normaler Kurs ('course') oder eComuniity ('ecom')

public

Returns:: string - Type

Settings::getDBSettings ( )

Gibt Daten aus Datenbank.courses zurueck.

private

Returns:: string[] - 'Name' - Name der Veranstaltung 'ShortName' - Kurzname der Veranstaltung 'Semester' - Semester i.d. Veranstaltung stattfindet ("03WS") 'OpenDate' - Starttag des Anmeldeverfahrens 'CloseDate' - Endtag des Anmeldeverfahrens 'RegPass' - Passwort zur Anmeldung 'MaxStudents' - Maximale Teilnehmerzahl 'UseWaitinglist' - soll Warteliste benutzt werden 'Info' - allgemein zugaengliche Information

Settings::getFAQ ( )

Gibt die faq-url zurück

public

Returns:: string - FAQ-URL

Settings::getID ( )

Gibt die ID der Veranstaltung zurueck.

public

Returns:: integer - ID der Veranstaltung

Settings::getInfo ( )

Gibt die allgemein zugaengliche Information zurueck.

public

Returns:: string - Infostring

Settings::getKeywords ( )

Gibt die Stichwörter der Veranstaltung zurück.

public

Returns:: string - Stichwörter der Veranstaltung

Settings::getMaxStudents ( )

Gibt die Anzahl der maximal teilnehmenden Studenten zurueck.

public

Returns:: integer - maximale Anzahl der Studenten

Settings::getModulbeschreibung_ID ( )

Settings::getModulShortCut ( )

Gibt das Modulkürzel der Veranstaltung zurueck.

public

Returns:: string - Modulkürzel der Veranstaltung

Settings::getName ( )

Gibt den Namen der Veranstaltung zurueck.

public

Returns:: string - Name der Veranstaltung

Settings::getOpendate ( )

Gibt das Startdatum fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Startdatum

Settings::getRegpass ( )

Gibt das Passwort fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Passwort

Settings::getSemester ( )

Gibt das Semester der Veranstaltung zurueck.

public

Returns:: string - Semester, in dem die Veranstaltung stattfindet ( In der Form "04SS" bzw. "03WS" )

Settings::getShortname ( )

Gibt den Kurznamen der Veranstaltung zurueck.

public

Returns:: string - Kurzname der Veranstaltung

Settings::getStyle ( )

Gibt den Namen des kursspezifischen Style zurück.

public

Returns:: string Name des kursspezifischen Style

Settings::getUseWaitinglist ( )

Gibt zurueck, ob eine Warteliste beim Anmeldeverfahren benutzt wird.

public

Returns:: integer - 1, falls Warteliste benutzt wird 0, falls nicht

Settings::hasRegistrationStarted ( $ now )

Parameters:

$now

Zeitstempel in Sekunden

Returns:: bool

Settings::registrationIsActive ( )

Prueft, ob Anmeldeverfahren geoeffnet.

public

Returns:: bool - true, falls Anmeldung moeglich false, falls Anmeldeverfahren vorbei oder noch nicht begonnen

Settings::resetErrors ( )

Loescht alle Fehlerstrings im Objekt.

public

Returns:: void

Settings::setClosedate ( $ closedate )

Setzt das Enddatum fuer das Anmeldeverfahren.

public

Parameters:

string

$closedate - Enddatum

Returns:: bool - true, wenn Enddatum gesetzt false, falls Enddatum nicht gestzt werden konnte

Settings::setFAQURL ( $ faq )

Settings::setInfo ( $ info )

Setzt die allgemein zugaengliche Information fuer die Veranstaltung.

public

Parameters:

string

$info - Infostring

Returns:: bool - true, wenn Info gesetzt false, falls Info nicht gestzt werden konnte

Settings::setKeywords ( $ keywords )

Setzt die Stichwörter für die Veranstaltung.

public

Parameters:

string

$keywords - Stichwörter der Veranstaltung

Returns:: bool - true, wenn Stichwörter gesetzt false, falls Stichwörter nicht gestzt werden konnten

Settings::setMaxStudents ( $ count )

Setzt die maximale Anzahl der an der Veranstaltung teilnehmenden Studenten.

public

Parameters:

integer

$count - Anzahl

Returns:: bool - true, wenn Anzahl gesetzt false, falls Anzahl nicht gestzt werden konnte

Settings::setModulbeschreibung_ID ( $ modulID )

Settings::setModulShortCut ( $ modulShortCut )

Setzt das Modulkürzel.

public

Parameters:

string

$modulShortCut - Kurzame der Veranstaltung

Returns:: bool - true, wenn Modulkürzel gesetzt false, falls Modulkürzel nicht gestzt werden konnte

Settings::setName ( $ name )

Setzt den Veranstaltungsnamen.

public

Parameters:

string

$name - Name der Veranstaltung

Returns:: bool - true, wenn Name gesetzt false, falls Name nicht gestzt werden konnte

Settings::setOpendate ( $ opendate )

Setzt das Startdatum fuer das Anmeldeverfahren.

public

Parameters:

string

$opendate - Startdatum

Returns:: bool - true, wenn Startdatum gesetzt false, falls Startdatum nicht gestzt werden konnte

Settings::setRegpass ( $ regpass )

Setzt das Passwort fuer das Anmeldeverfahren.

public

Parameters:

string

$regpass - Passwort

Returns:: bool - true, wenn Passwort gesetzt false, falls Passwort nicht gestzt werden konnte

Settings::setSemester ( $ semester )

Setzt das Semester, in dem die Veranstaltung stattfindet.

public

Parameters:

string

$semester - Semesterstring in der Form "WS 03/04" oder "SS 04"

Returns:: bool - true, wenn Semester gesetzt false, falls Semester nicht gestzt werden konnte

Settings::setShortname ( $ shortname )

Setzt den Veranstaltungskurznamen.

public

Parameters:

string

$shortname - Kurzame der Veranstaltung

Returns:: bool - true, wenn Kurzname gesetzt false, falls Kurzname nicht gestzt werden konnte

Settings::setStyle ( $ style )

Setzt den kursspezifischen Style.

public

Parameters:

string

$style - Name des Styles

Returns:: bool - true, wenn Style gesetzt false, falls Style nicht gesetzt werden konnte

Settings::Settings ( $ courseid )

Konstruktor.

public

Parameters:

integer

$courseid - ID der Veranstaltung

Returns:: bool - true, wenn Objekt fehlerfrei erzeugt false, wenn Fehler auftraten

Settings::setUseWaitinglist ( $ use )

Legt fest, ob beim Anmeldeverfahren eine Warteliste benutzt werden soll.

public

Parameters:

integer

$use - 1 fuer ja, 0 fuer nein

Returns:: bool - true, wenn gesetzt false, falls nicht gestzt werden konnte

Settings::validateInfo ( $ info ) [static]

Ueberprueft eine Veranstaltungsinformation auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, Zeilenumbrueche, sowie die folgenden Sonderzeichen : ' ','/','Ä','Ö','Ü','ä','ö','ü','-','+','#','(',')',',','.',':','!',';','[',']','{','}','=','*'.

public

Parameters:

string

$pass - Veranstaltungsinformation, die geprueft werden soll.

Returns:: string "" - falls Information gueltig. $errorMessage - falls ungueltige Zeichen in Information enthalten.

Settings::validateKeywords ( $ keywords ) [static]

Ueberprueft die Stichwörter auf gueltige Zeichen.

public

Parameters:

string

$keywords - Stichwörter, der geprueft werden soll.

Returns:: string "" - falls Stichwörter gueltig. $errorMessage - falls ungültig.

Settings::validateMaxStudents ( $ maxStudents )

Settings::validateName ( $ name ) [static]

Ueberprueft einen Veranstaltungsnamen auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, sowie die folgenden Sonderzeichen : ' ', '/', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', '-', '+', '#', '(', ')'

public

Parameters:

string

$coursename - Veranstaltungsname, der geprueft werden soll.

Returns:: string "" - falls Name gueltig. $errorMessage - falls ungueltige Zeichen in Name enthalten.

Settings::validateRegistrationPassword ( $ pass ) [static]

Ueberprueft einen Veranstaltungspasswort auf gueltige Zeichen.

public

Parameters:

string

$pass - Veranstaltungspasswort, das geprueft werden soll.

Returns:: string "" - falls Passwort gueltig. $errorMessage - falls ungueltige Zeichen in Passwort enthalten.

Settings::validateShortname ( $ shortname ) [static]

Ueberprueft einen Kurznamen auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, sowie die folgenden Sonderzeichen : ' ', '/', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', '-', '+', '#', '(', ')'

public

Parameters:

string

$shortname - Kurzname, der geprueft werden soll.

Returns:: string "" - falls Name gueltig. $errorMessage - falls ungueltige Zeichen in Name enthalten.

Settings::validateStyle ( $ style ) [static]

Ueberprueft einen eStudy Style-Namen.

public

Parameters:

string

$style - Der zu prüfende Style-Name

Returns:: string "" - falls der Name gueltig ist $errorMessage - falls der Name ungueltig ist.

Member Data Documentation

Settings::$closed

Settings::$closedate

Settings::$errors

Settings::$faq_url

Settings::$id

Settings::$info

Settings::$keywords

Settings::$maxstudents

Settings::$modulbeschreibung_ID

Settings::$modulShortCut

Settings::$name

Settings::$opendate

Settings::$regpass

Settings::$semester

Settings::$shortname

Settings::$style

Settings::$type

Settings::$usewaitinglist

The documentation for this class was generated from the following file:

web/courses/classes/class.Settings.inc.php


Public Member Functions
	Settings ($courseid)
	addError ($errorString)
	resetErrors ()
	getDBSettings ()
	setName ($name)
	setShortname ($shortname)
	setModulShortCut ($modulShortCut)
	setStyle ($style)
	setKeywords ($keywords)
	setFAQURL ($faq)
	setSemester ($semester)
	setOpendate ($opendate)
	setClosedate ($closedate)
	setRegpass ($regpass)
	setMaxStudents ($count)
	setUseWaitinglist ($use)
	setInfo ($info)
	setModulbeschreibung_ID ($modulID)
	getID ()
	getName ()
	getShortname ()
	getModulShortCut ()
	getKeywords ()
	getSemester ()
	getOpendate ()
	getClosedate ()
	getRegpass ()
	getUseWaitinglist ()
	getMaxStudents ()
	getInfo ()
	getClosed ()
	getStyle ()
	getFAQ ()
	getCourseType ()
	getModulbeschreibung_ID ()
	registrationIsActive ()
	hasRegistrationStarted ($now)
	validateMaxStudents ($maxStudents)
Static Public Member Functions
	validateName ($name)
	validateShortname ($shortname)
	validateKeywords ($keywords)
	formatName ($name)
	validateRegistrationPassword ($pass)
	validateInfo ($info)
	formatInfo ($info)
	validateStyle ($style)
	echoSettingsDialog ()
Public Attributes
	$id
	$name
	$shortname
	$modulShortCut
	$semester
	$keywords
	$opendate
	$closedate
	$regpass
	$maxstudents
	$usewaitinglist
	$closed
	$info
	$faq_url
	$style
	$type
	$modulbeschreibung_ID
	$errors